<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen 2.7.0" />

	<title>Class Swift_Transport_MailTransport | nort</title>

	<script type="text/javascript" src="resources/combined.js?1481722677"></script>
	<script type="text/javascript" src="elementlist.js?1094816827"></script>
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?1567499433" />

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
			<h3>Packages</h3>
			<ul>
				<li><a href="package-App.html">App<span></span></a>
						<ul>
				<li><a href="package-App.Saas.html">Saas</a>
						</li>
				<li><a href="package-App.saas.html">saas</a>
						</li>
				<li><a href="package-App.SaaS.html">SaaS<span></span></a>
						<ul>
				<li><a href="package-App.saas.Logic.html">Logic</a>
						</li>
				<li><a href="package-App.SaaS.SaaS.html">SaaS</a>
						</li>
				<li><a href="package-App.Saas.Tables.html">Tables</a>
						</li>
				<li><a href="package-App.Saas.Vo.html">Vo</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-aqua.html">aqua<span></span></a>
						<ul>
				<li><a href="package-aqua.tools.html">tools<span></span></a>
						<ul>
				<li><a href="package-aqua.tools.Monitor.html">Monitor</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-flashservices.html">flashservices<span></span></a>
						<ul>
				<li><a href="package-flashservices.adapters.html">adapters</a>
						</li>
				<li><a href="package-flashservices.debug.html">debug</a>
						</li>
				<li><a href="package-flashservices.exception.html">exception</a>
						</li>
				<li><a href="package-flashservices.filters.html">filters</a>
						</li>
				<li><a href="package-flashservices.io.html">io</a>
						</li>
				<li><a href="package-flashservices.sql.html">sql</a>
						</li>
				<li><a href="package-flashservices.util.html">util</a>
						</li>
							</ul></li>
				<li><a href="package-Mekayotl.html">Mekayotl<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.core.html">core</a>
						</li>
				<li><a href="package-Mekayotl.database.html">database<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.database.dal.html">dal</a>
						</li>
				<li><a href="package-Mekayotl.database.mysql.html">mysql</a>
						</li>
				<li><a href="package-Mekayotl.database.sqlite.html">sqlite</a>
						</li>
							</ul></li>
				<li><a href="package-Mekayotl.tools.html">tools<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.tools.render.html">render<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.tools.render.html.html">html</a>
						</li>
							</ul></li>
				<li><a href="package-Mekayotl.tools.renders.html">renders</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-None.html">None</a>
						</li>
				<li><a href="package-PHP.html">PHP</a>
						</li>
				<li><a href="package-PHPMailer.html">PHPMailer</a>
						</li>
				<li><a href="package-Services.html">Services<span></span></a>
						<ul>
				<li><a href="package-Services.JSON.html">JSON</a>
						</li>
							</ul></li>
				<li class="active"><a href="package-Swift.html">Swift<span></span></a>
						<ul>
				<li><a href="package-Swift.ByteStream.html">ByteStream</a>
						</li>
				<li><a href="package-Swift.CharacterStream.html">CharacterStream</a>
						</li>
				<li><a href="package-Swift.Encoder.html">Encoder</a>
						</li>
				<li><a href="package-Swift.Events.html">Events</a>
						</li>
				<li><a href="package-Swift.KeyCache.html">KeyCache</a>
						</li>
				<li><a href="package-Swift.Mailer.html">Mailer</a>
						</li>
				<li><a href="package-Swift.Mime.html">Mime</a>
						</li>
				<li><a href="package-Swift.Plugins.html">Plugins</a>
						</li>
				<li class="active"><a href="package-Swift.Transport.html">Transport</a>
						</li>
							</ul></li>
			</ul>
		</div>

		<hr />


		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li><a href="class-Swift_FailoverTransport.html">Swift_FailoverTransport</a></li>
				<li><a href="class-Swift_LoadBalancedTransport.html">Swift_LoadBalancedTransport</a></li>
				<li><a href="class-Swift_MailTransport.html">Swift_MailTransport</a></li>
				<li><a href="class-Swift_Plugins_Loggers_ArrayLogger.html">Swift_Plugins_Loggers_ArrayLogger</a></li>
				<li><a href="class-Swift_Plugins_Loggers_EchoLogger.html">Swift_Plugins_Loggers_EchoLogger</a></li>
				<li><a href="class-Swift_SendmailTransport.html">Swift_SendmailTransport</a></li>
				<li><a href="class-Swift_SmtpTransport.html">Swift_SmtpTransport</a></li>
				<li><a href="class-Swift_Transport_AbstractSmtpTransport.html">Swift_Transport_AbstractSmtpTransport</a></li>
				<li><a href="class-Swift_Transport_Esmtp_Auth_CramMd5Authenticator.html">Swift_Transport_Esmtp_Auth_CramMd5Authenticator</a></li>
				<li><a href="class-Swift_Transport_Esmtp_Auth_LoginAuthenticator.html">Swift_Transport_Esmtp_Auth_LoginAuthenticator</a></li>
				<li><a href="class-Swift_Transport_Esmtp_Auth_PlainAuthenticator.html">Swift_Transport_Esmtp_Auth_PlainAuthenticator</a></li>
				<li><a href="class-Swift_Transport_Esmtp_AuthHandler.html">Swift_Transport_Esmtp_AuthHandler</a></li>
				<li><a href="class-Swift_Transport_EsmtpTransport.html">Swift_Transport_EsmtpTransport</a></li>
				<li><a href="class-Swift_Transport_FailoverTransport.html">Swift_Transport_FailoverTransport</a></li>
				<li><a href="class-Swift_Transport_LoadBalancedTransport.html">Swift_Transport_LoadBalancedTransport</a></li>
				<li class="active"><a href="class-Swift_Transport_MailTransport.html">Swift_Transport_MailTransport</a></li>
				<li><a href="class-Swift_Transport_SendmailTransport.html">Swift_Transport_SendmailTransport</a></li>
				<li><a href="class-Swift_Transport_SimpleMailInvoker.html">Swift_Transport_SimpleMailInvoker</a></li>
				<li><a href="class-Swift_Transport_StreamBuffer.html">Swift_Transport_StreamBuffer</a></li>
			</ul>

			<h3>Interfaces</h3>
			<ul>
				<li><a href="class-Swift_Plugins_Logger.html">Swift_Plugins_Logger</a></li>
				<li><a href="class-Swift_Transport.html">Swift_Transport</a></li>
				<li><a href="class-Swift_Transport_Esmtp_Authenticator.html">Swift_Transport_Esmtp_Authenticator</a></li>
				<li><a href="class-Swift_Transport_EsmtpHandler.html">Swift_Transport_EsmtpHandler</a></li>
				<li><a href="class-Swift_Transport_IoBuffer.html">Swift_Transport_IoBuffer</a></li>
				<li><a href="class-Swift_Transport_MailInvoker.html">Swift_Transport_MailInvoker</a></li>
				<li><a href="class-Swift_Transport_SmtpAgent.html">Swift_Transport_SmtpAgent</a></li>
			</ul>


			<h3>Exceptions</h3>
			<ul>
				<li><a href="class-Swift_Plugins_Pop_Pop3Exception.html">Swift_Plugins_Pop_Pop3Exception</a></li>
				<li><a href="class-Swift_TransportException.html">Swift_TransportException</a></li>
			</ul>


		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="" />
		<input type="hidden" name="ie" value="UTF-8" />
		<input type="text" name="q" class="text" />
		<input type="submit" value="Search" />
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li>
				<a href="package-Swift.Transport.html" title="Summary of Swift\Transport"><span>Package</span></a>
			</li>
			<li class="active">
<span>Class</span>			</li>
		</ul>
		<ul>
			<li>
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
			</li>
		</ul>
		<ul>
		</ul>
	</div>

<div id="content" class="class">
	<h1>Class Swift_Transport_MailTransport</h1>


	<div class="description">
	
<p>Sends Messages using the mail() function.</p>

<p>It is advised that users do not use this transport if at all possible since a
number of plugin features cannot be used in conjunction with this transport due
to the internal interface in PHP itself.</p>

<p>The level of error reporting with this transport is incredibly weak, again
due to limitations of PHP's internal mail() function. You'll get an
all-or-nothing result from sending.</p>

	</div>

	<dl class="tree">
		<dd style="padding-left:0px">
<b><span>Swift_Transport_MailTransport</span></b>			
			 implements 
				<a href="class-Swift_Transport.html"><span>Swift_Transport</span></a>
			
			
		</dd>
	</dl>


	<div>
		<h4>Direct known subclasses</h4>
			<a href="class-Swift_MailTransport.html">Swift_MailTransport</a>
	</div>






	<div class="info">
		
		
		
		<b>Package:</b> <a href="package-Swift.html">Swift</a>\<a href="package-Swift.Transport.html">Transport</a><br />

				<b>Author:</b>
				Chris Corbyn<br />
		<b>Located at</b> <a href="source-class-Swift_Transport_MailTransport.html#11" title="Go to source code">lib/php/externals/swift/classes/Swift/Transport/MailTransport.php</a><br />
	</div>


	<table class="summary" id="methods">
	<caption>Methods summary</caption>
	<tr data-order="__construct" id="___construct">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#___construct">#</a>
		<code><a href="source-class-Swift_Transport_MailTransport.html#40" title="Go to source code">__construct</a>( <span><code><a href="class-Swift_Transport_MailInvoker.html">Swift_Transport_MailInvoker</a></code> <var>$invoker</var></span>, <span><code><a href="class-Swift_Events_EventDispatcher.html">Swift_Events_EventDispatcher</a></code> <var>$eventDispatcher</var></span> )</code>

		<div class="description short">
			
<p>Create a new MailTransport with the $log.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Create a new MailTransport with the $log.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$invoker</var></dt>
					<dd><code>Swift_Transport_Log</code><br>$log</dd>
					<dt><var>$eventDispatcher</var></dt>
					<dd></dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	<tr data-order="isStarted" id="_isStarted">

		<td class="attributes"><code>
			 public 
			boolean
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_isStarted">#</a>
		<code><a href="source-class-Swift_Transport_MailTransport.html#52" title="Go to source code">isStarted</a>( )</code>

		<div class="description short">
			
<p>Not used.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Not used.</p>




				<h4>Returns</h4>
				<div class="list">
					<code>boolean</code><br />
				</div>




				<h4>Implementation of</h4>
				<div class="list"><code><a href="class-Swift_Transport.html#_">Swift_Transport::isStarted</a></code></div>
		</div>
		</div></td>
	</tr>
	<tr data-order="start" id="_start">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_start">#</a>
		<code><a href="source-class-Swift_Transport_MailTransport.html#61" title="Go to source code">start</a>( )</code>

		<div class="description short">
			
<p>Not used.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Not used.</p>








				<h4>Implementation of</h4>
				<div class="list"><code><a href="class-Swift_Transport.html#_">Swift_Transport::start</a></code></div>
		</div>
		</div></td>
	</tr>
	<tr data-order="stop" id="_stop">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_stop">#</a>
		<code><a href="source-class-Swift_Transport_MailTransport.html#69" title="Go to source code">stop</a>( )</code>

		<div class="description short">
			
<p>Not used.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Not used.</p>








				<h4>Implementation of</h4>
				<div class="list"><code><a href="class-Swift_Transport.html#_">Swift_Transport::stop</a></code></div>
		</div>
		</div></td>
	</tr>
	<tr data-order="setExtraParams" id="_setExtraParams">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_setExtraParams">#</a>
		<code><a href="source-class-Swift_Transport_MailTransport.html#77" title="Go to source code">setExtraParams</a>( <span>string <var>$params</var></span> )</code>

		<div class="description short">
			
<p>Set the additional parameters used on the mail() function.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Set the additional parameters used on the mail() function.</p>

<p>This string is formatted for sprintf() where %s is the sender address.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$params</var></dt>
					<dd><code>string</code></dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	<tr data-order="getExtraParams" id="_getExtraParams">

		<td class="attributes"><code>
			 public 
			string
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getExtraParams">#</a>
		<code><a href="source-class-Swift_Transport_MailTransport.html#91" title="Go to source code">getExtraParams</a>( )</code>

		<div class="description short">
			
<p>Get the additional parameters used on the mail() function.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Get the additional parameters used on the mail() function.</p>

<p>This string is formatted for sprintf() where %s is the sender address.</p>




				<h4>Returns</h4>
				<div class="list">
					<code>string</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="send" id="_send">

		<td class="attributes"><code>
			 public 
			integer
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_send">#</a>
		<code><a href="source-class-Swift_Transport_MailTransport.html#104" title="Go to source code">send</a>( <span><code><a href="class-Swift_Mime_Message.html">Swift_Mime_Message</a></code> <var>$message</var></span>, <span>string[] <var>&amp; $failedRecipients</var> = <span class="php-keyword1">NULL</span></span> )</code>

		<div class="description short">
			
<p>Send the given Message.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Send the given Message.</p>

<p>Recipient/sender data will be retreived from the Message API. The return
value is the number of recipients who were accepted for delivery.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$message</var></dt>
					<dd><code><code><a href="class-Swift_Mime_Message.html">Swift_Mime_Message</a></code></code></dd>
					<dt><var>$failedRecipients</var></dt>
					<dd><code>string[]</code><br>&amp;$failedRecipients to collect failures by-reference</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>integer</code><br />
				</div>




				<h4>Implementation of</h4>
				<div class="list"><code><a href="class-Swift_Transport.html#_">Swift_Transport::send</a></code></div>
		</div>
		</div></td>
	</tr>
	<tr data-order="registerPlugin" id="_registerPlugin">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_registerPlugin">#</a>
		<code><a href="source-class-Swift_Transport_MailTransport.html#206" title="Go to source code">registerPlugin</a>( <span><code><a href="class-Swift_Events_EventListener.html">Swift_Events_EventListener</a></code> <var>$plugin</var></span> )</code>

		<div class="description short">
			
<p>Register a plugin.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Register a plugin.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$plugin</var></dt>
					<dd><code><code><a href="class-Swift_Events_EventListener.html">Swift_Events_EventListener</a></code></code></dd>
				</dl></div>





				<h4>Implementation of</h4>
				<div class="list"><code><a href="class-Swift_Transport.html#_">Swift_Transport::registerPlugin</a></code></div>
		</div>
		</div></td>
	</tr>
	</table>










</div>

	<div id="footer">
		nort API documentation generated by <a href="http://apigen.org">ApiGen 2.7.0</a>
	</div>
</div>
</div>
</body>
</html>
